gtktextview: document how to get line space
authorBastian Ilsø <bastianilso@src.gnome.org>
Wed, 1 Apr 2015 20:46:46 +0000 (22:46 +0200)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 24 May 2016 03:02:37 +0000 (23:02 -0400)
adds a paragraph to gtk_text_view_get_pixels_below_lines(),
describing how it can be used together with
gtk_text_view_get_pixels_above_lines() to get the total
amount of line spacing between two paragraphs.

https://bugzilla.gnome.org/show_bug.cgi?id=747206

gtk/gtktextview.c

index cc091691a9f7894cdb80377573a280bc1dbeee88..22b3a5942d843165d922f4761392217f3c6cf0fe 100644 (file)
@@ -3009,6 +3009,8 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
  * @text_view: a #GtkTextView
  * 
  * Gets the default number of pixels to put above paragraphs.
+ * Adding this function with gtk_text_view_get_pixels_below_lines()
+ * is equal to the line space between each paragraph.
  * 
  * Returns: default number of pixels above paragraphs
  **/
@@ -3058,7 +3060,10 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
  * @text_view: a #GtkTextView
  * 
  * Gets the value set by gtk_text_view_set_pixels_below_lines().
- * 
+ *
+ * The line space is the sum of the value returned by this function and the
+ * value returned by gtk_text_view_get_pixels_above_lines().
+ *
  * Returns: default number of blank pixels below paragraphs
  **/
 gint